﻿/*
Copyright 2009 Matías Fidemraizer (www.matiasfidemraizer.com).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

using System;

namespace Comkarl.Architecture.Patterns.MVC.Entities
{
    /// <summary>
    /// An exception thrown when an error is found when a view is registered in some controller.
    /// </summary>
    /// <typeparam name="TEntityIdentifierName">
    /// The type for the identifier's name.
    /// </typeparam>
    public sealed class ViewRegisteringException<TEntityIdentifierName> : ControlledEntityException<TEntityIdentifierName> where TEntityIdentifierName : IEquatable<TEntityIdentifierName>
    {
        #region "Constructor"
        /// <summary>
        /// Default constructor.
        /// </summary>
        /// <param name="message">
        /// A custom message to show when this is thrown.
        /// </param>
        /// <param name="currentEntity">
        /// The related entity on or where which the exception got thrown.
        /// </param>
        /// <param name="innerException">
        /// An optional exception which can be set if some underlying exception has been thrown.
        /// </param>
        public ViewRegisteringException(string id, View<TEntityIdentifierName> currentView, Exception innerException)
            : base(id, currentView, innerException)
        {
        }
        #endregion

        #region "Properties"
        /// <summary>
        /// Gets the model on or where the exception got thrown.
        /// </summary>
        new public View<TEntityIdentifierName> CurrentEntity
        {
            get
            {
                return (View<TEntityIdentifierName>)CurrentEntity;
            }
        }
        #endregion
    }
}
